@stdlib/assert-has-own-property

What is @stdlib/assert-has-own-property?

@stdlib/assert-has-own-property is a utility package that provides a function to check if an object has a specified property as its own (not inherited) property.

What are @stdlib/assert-has-own-property's main functionalities?

Check if an object has a specified own property

This feature allows you to check if a given object has a specified property as its own property. The function returns `true` if the property exists and `false` otherwise.

const hasOwnProp = require('@stdlib/assert-has-own-property');

const obj = { 'a': 1, 'b': 2 };

console.log(hasOwnProp(obj, 'a')); // true
console.log(hasOwnProp(obj, 'c')); // false

Other packages similar to @stdlib/assert-has-own-property

has

The 'has' package provides a similar functionality to @stdlib/assert-has-own-property. It checks if an object has a property directly on itself (not inherited). It is a lightweight and straightforward alternative.

lodash.has

The 'lodash.has' method is part of the Lodash library, which is a utility library delivering consistency, modularity, and performance. It checks if a path is a direct property of an object. While it offers similar functionality, Lodash is a larger library with many additional utilities.

object-has

The 'object-has' package is another alternative that checks if an object has a property directly on itself. It is a simple and focused package, similar in scope to @stdlib/assert-has-own-property.

README

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

hasOwnProperty

Test if an object has a specified property.

Installation

npm install @stdlib/assert-has-own-property

Usage

var hasOwnProp = require( '@stdlib/assert-has-own-property' );

hasOwnProp( value, property )

Returns a boolean indicating if a value has a specified property.

var value = {
    'beep': 'boop'
};

var bool = hasOwnProp( value, 'beep' );
// returns true

bool = hasOwnProp( value, 'bap' );
// returns false

Notes

• In contrast to the native Object.prototype.hasOwnProperty, this function does not throw when provided null or undefined. Instead, the function returns false.

  var bool = hasOwnProp( null, 'a' );
  // returns false
  
  bool = hasOwnProp( void 0, 'a' );
  // returns false
  

• Value arguments other than null or undefined are coerced to objects.

  var bool = hasOwnProp( 'beep', 'length' );
  // returns true
  

• Property arguments are coerced to strings.

  var value = {
      'null': false
  };
  var bool = hasOwnProp( value, null );
  // returns true
  
  value = {
      '[object Object]': false
  };
  bool = hasOwnProp( value, {} );
  // returns true
  

Examples

var hasOwnProp = require( '@stdlib/assert-has-own-property' );

var bool = hasOwnProp( { 'a': 'b' }, 'a' );
// returns true

bool = hasOwnProp( { 'a': 'b' }, 'c' );
// returns false

bool = hasOwnProp( { 'a': 'b' }, null );
// returns false

bool = hasOwnProp( {}, 'hasOwnProperty' );
// returns false

bool = hasOwnProp( null, 'a' );
// returns false

bool = hasOwnProp( void 0, 'a' );
// returns false

bool = hasOwnProp( { 'null': false }, null );
// returns true

bool = hasOwnProp( { '[object Object]': false }, {} );
// returns true

---

See Also

• @stdlib/assert-has-property: test if an object has a specified property, either own or inherited.

---

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

---

License

See LICENSE.

Copyright

Copyright © 2016-2023. The Stdlib Authors.

Changelog

0.1.1 (2023-10-03)

No changes reported for this release.

</section> <!-- /.release --> <section class="release" id="v0.1.0">